Skip to content

[clang][docs] Add all clang-tools-extra to 'ClangTools.rst' #148622

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 19, 2025

Conversation

weirdsmiley
Copy link
Member

The 'Extra Clang Tools' section does not mention any other clang tool except clang-tidy. This adds all missing extra tools to sync documentation between this page and the main page of Extra Clang Tools.

Fixes #148538

@llvmbot llvmbot added the clang Clang issues not falling into any other category label Jul 14, 2025
@llvmbot
Copy link
Member

llvmbot commented Jul 14, 2025

@llvm/pr-subscribers-clang

Author: Manas (weirdsmiley)

Changes

The 'Extra Clang Tools' section does not mention any other clang tool except clang-tidy. This adds all missing extra tools to sync documentation between this page and the main page of Extra Clang Tools.

Fixes #148538


Full diff: https://github.com/llvm/llvm-project/pull/148622.diff

1 Files Affected:

  • (modified) clang/docs/ClangTools.rst (+35)
diff --git a/clang/docs/ClangTools.rst b/clang/docs/ClangTools.rst
index 60e21590f9eb3..25cdd69d19cdc 100644
--- a/clang/docs/ClangTools.rst
+++ b/clang/docs/ClangTools.rst
@@ -97,6 +97,41 @@ linter tool. It provides an extensible framework for building compiler-based
 static analyses detecting and fixing bug-prone patterns, performance,
 portability and maintainability issues.
 
+``clang-include-fixer``
+-----------------------
+
+`clang-include-fixer <https://clang.llvm.org/extra/clang-include-fixer.html>`_
+automates the addition of missing ``#include`` directives in a C++ file. It adds
+missing namespace qualifiers to unidentified symbols when necessary.
+
+``modularize``
+--------------
+
+`modularize <https://clang.llvm.org/extra/modularize.html>`_ is a standalone
+tool that checks whether a set of headers provides the consistent definitions
+required to use modules.
+
+``pp-trace``
+------------
+
+`pp-trace <https://clang.llvm.org/extra/pp-trace.html>`_ is a standalone tool
+that traces preprocessor activity. It’s also used as a test of Clang’s
+PPCallbacks interface. It runs a given source file through the Clang
+preprocessor, displaying selected information from callback functions overridden
+in a PPCallbacks derivation. The output is in a high-level YAML format,
+described in pp-trace Output Format.
+
+``clangd``
+----------
+
+`clangd <https://clangd.llvm.org/>`_ is a language server that can work with
+many editors via a plugin.
+
+``clang-doc``
+-------------
+
+`clang-doc <https://clang.llvm.org/extra/clang-doc.html>`_ is a tool for
+generating C and C++ documentation from source code and comments.
 
 Ideas for new Tools
 ===================

@weirdsmiley weirdsmiley requested a review from vbvictor July 14, 2025 12:54
@vbvictor vbvictor requested a review from EugeneZelenko July 14, 2025 19:14
Copy link
Contributor

@vbvictor vbvictor left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, but please wait some time for EugeneZelenko to leave a review.

@vbvictor vbvictor changed the title [clang][docs] Add all clang-tools-extra [clang][docs] Add all clang-tools-extra to 'ClangTools.rst' Jul 16, 2025
@carlosgalvezp
Copy link
Contributor

Maybe this has been already discussed, but it feels strange to me to capitalize the names of the tools, like Clang-Tidy. Why is that? I don't know what is "correct" in this case, do we have such a pattern in other documents?

@EugeneZelenko
Copy link
Contributor

Maybe this has been already discussed, but it feels strange to me to capitalize the names of the tools, like Clang-Tidy. Why is that? I don't know what is "correct" in this case, do we have such a pattern in other documents?

This is how tools are named themself when written as plain text (not with :program: prefix).

The 'Extra Clang Tools' section does not mention any other clang tool
except clang-tidy. This adds all missing extra tools to sync
documentation between this page and the main page of Extra Clang Tools.

Fixes llvm#148538
@vbvictor vbvictor merged commit 54492c2 into llvm:main Jul 19, 2025
10 checks passed
mahesh-attarde pushed a commit to mahesh-attarde/llvm-project that referenced this pull request Jul 28, 2025
)

The 'Extra Clang Tools' section does not mention any other clang tool
except clang-tidy. This adds all missing extra tools to sync
documentation between this page and the main page of Extra Clang Tools.

Fixes llvm#148538
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
clang Clang issues not falling into any other category
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[clang-tools-extra] Add more documented tools to ClangTools.html
6 participants